table of contents
lsm_fs_list(3) | Libstoragemgmt C API Manual | lsm_fs_list(3) |
NAME¶
lsm_fs_list - Gets a list of file systems on this connection.
SYNOPSIS¶
int lsm_fs_list (lsm_connect *conn, const char *search_key, const char *search_value, lsm_fs **fs[], uint32_t *fs_count, lsm_flag flags);
ARGUMENTS¶
- conn
- Valid connection.
- search_key
- Search key (NULL for all) Valid search keys are: "id", "system_id" and "pool_id".
- search_value
- Search value.
- fs[]
- Output pointer of lsm_fs array. It should be manually freed by lsm_fs_record_array_free.
- fs_count
- Number of file systems.
- flags
- Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
VERSION¶
1.0
DESCRIPTION¶
Gets a list of file systems on this connection. Network Attached
Storage (NAS) Storage array can expose a Filesystem to host OS via IP
network using NFS or CIFS protocol. The host OS treats it as a mount point
or a folder containing files depending on client operating system. File
system properties could be retrieved by these functions:
* lsm_fs_id_get
* lsm_fs_name_get
* lsm_fs_system_id_get
* lsm_fs_pool_id_get
* lsm_fs_total_space_get
* lsm_fs_free_space_get
CAPABILITY¶
LSM_CAP_FS
RETURN¶
Error code as enumerated by 'lsm_error_number'.
* LSM_ERR_OK
On success or searched value not found.
* LSM_ERR_INVALID_ARGUMENT
When any argument is NULL or invalid flags or invalid search
key.
* LSM_ERR_NO_SUPPORT
Not supported.
lsm_fs_list | April 2021 |